PLAN

NAME

SYNOPSIS

DESCRIPTION

The type of every line depends on the first character of the line. The second character is always a single TAB character. All following characters are arguments. Comments and blank lines (which are ignored) can appear anywhere. "Header types" are all at the beginning of the file before the first "entry type".

TYPES THAT CAN APPEAR ANYWHERE:

#

Comment line. The rest of the line is ignored.

HEADER TYPES:

o

Options. The argument consists of 12 consecutive flag characters, and five numerical arguments. In order, the flags are:

s

sunday first

a

12-hour (am/pm) mode

m

US date format mm/dd/yy

d

auto-delete past options

j

show julian dates

w

show week numbers

n

show the next three notes, rather than the first three

b

numeric warning entry mode, rather than popup mode

w

show advance warnings graphically in week view

u

show user names next to note strings in week view

-

not used, for future extensions

-

not used, for future extensions

-

not used, for future extensions

After the flags, the default advance-warning times that are used when the small buttons at the left edge of the advance-warning popup are pressed. The first number is the early time, the second the last time. Both are in seconds. The third number is the expiration time of notifier windows; zero or a missing number means the windows live forever, any other number is the maximum lifetime in seconds. The fourth and fifth numbers are the hours at the left and right margin of the week view; defaults are 8 and 20.

t

Time adjustment parameters as defined with the Adjust Time popup. The five numeric parameters are the offset to the system clock in seconds, the timezone offset in seconds, the DST flag (0=always on, 1=always off, 2=automatic), and the Julian begin and end dates for automatic DST.

e

Early warning flags,

l

Late warning flags, and

a

alarm flags:
These three have the same format. The first three argument chars are flags, as specified in the Alarm Options popup. '-' means the flag is off, everything else means the flag is on. In order, the flags are:

w

show a color-coded window when the warning/alarm triggers

m

send mail when the warning/alarm triggers

x

execute a command when the warning/alarm triggers

The flags are followed by a single blank. The rest of the line is the command to execute when the warning/alarm triggers and the 'x' flag is on.

p

The print spooling string. When printing a PostScript calendar, the PostScript code is sent to stdin of this command.

m

The mailer program, as specified in the Alarm Options menu. Up to one "%s" is allowed, it is replaced by the (quoted) note string. "%s" is typically used for a subject.

U

Global user list parameters. Currently, there is only one integer argument; the number of users (the number of 'u' lines following). The user list is the list of "friends" whose public appointments appear in the week view.

u

One user in the user list. There are four arguments:

-

the user name

-

the user's home directory

-

0 if the user is shown, 1 if the user is suspended

-

the color used in the week view, a number in the range 0..7

ENTRY TYPES:

[0-9]

Begins an entry. This is the only mandatory line, all others that follow are optional. All following lines that do not begin with a numeric digit are extra information for the entry. Unlike all other types, there is no TAB character in the second column, the first character is the first digit of the trigger date.

The line consists of five date/time fields, seperated by at least one blank, and three flag characters that must be consecutive. As usual, flags are off if the character is '-', and on otherwise. The fields are:

1/2/3

trigger date, month/day/year. Year can be either 70..99,00..38, or 1970..2038. Do not enter appointments after 2037. If there is demand, I'll fix this bug in about 45 years.

1:2:3

trigger time, hour:minutes:seconds, in 24-hour format. 99:99:99 means that there is no alarm time ("-" in the time column).

1:2:3

length, hour:minutes:seconds, in 24-hour format

1:2:3

early-warning time, hour:minutes:seconds, in 24-hour format, 0:0:0 means there is no early warning

1:2:3

late-warning time, hour:minutes:seconds, in 24-hour format, 0:0:0 means there is no late warning

S

suspended (the green button at the left edge is off)

P

private (goes into the private dayplan file that has mode 0600)

N

no alarm (trigger warnings if nonzero, but no final alarm)

R

Add repetition information to the current entry. There are five numeric fields, separated by at least one blank. This one is particularly unsuited for human consumption, sorry.

1

trigger alarm every <1> days (in seconds)

2

delete alarm after this date (seconds since 1/1/70 0:00:00)

3

weekday bitmap and nth-week bitmap:
bit0=sunday ... bit6=saturday
bit8=first ... bit12=fifth, bit13=last

4

month day bitmap, bit0=last day of the month, bits 1..31=on that day of the month

5

if 1, the entry repeats every year; if 0, it doesn't.

N

Add a note string to the current entry. All characters that follow the TAB are part of the note string.

M

Add another line to the current entry's message. All characters that follow the TAB are part of the line. There can be multiple M lines, they all add to the message.

S

Add another line to the current entry's script. All characters that follow the TAB are part of the line. There can be multiple S lines, they all add to the script.

G

Reserved for group meetings, not currently used.

Index

NAME

SYNOPSIS

DESCRIPTION